/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.web.portlet.description;

/**
 * interface describing a portlet containing sub portlets.
 */
public interface ContainerPortletDescription
    extends PortletDescription
{

  /**
   * this enum represents the direction in which will be displayed the portlets
   * of this container.
   */
  public enum LayoutDirection
  {
    /**
     * vertical direction.
     */
    VERTICAL,
    /**
     * horizontal direction.
     */
    HORIZONTAL;
  }



  /**
   * return the name of the spring view that must generate the content of this
   * portlet.
   * 
   * @return the name of the spring view that must generate the content of this
   *         portlet
   */
  public String getViewName();



  /**
   * return the minimal number of servlet this container must have.
   * 
   * @return the minimal number of servlet this container must have
   */
  public int getMinNumberSubPortlets();



  /**
   * return the maximal number of servlet this container must have.
   * 
   * @return the maximal number of servlet this container must have
   */
  public int getMaxNumberSubPortlets();



  /**
   * return the direction in which will be displayed the portlets of this
   * container.
   * 
   * @return the direction in which will be displayed the portlets of this
   *         container
   */
  public LayoutDirection getLayoutDirection();
}
